blob: 16bdd55233f2f1a11a80f60dfa85b84145c836f6 [file] [log] [blame]
Junio C Hamano07824ce2006-04-25 07:36:541CONFIGURATION FILE
2------------------
3
4The git configuration file contains a number of variables that affect
Junio C Hamanof1d14802006-06-08 00:48:175the git command's behavior. They can be used by both the git plumbing
6and the porcelains. The variables are divided into sections, where
Junio C Hamano07824ce2006-04-25 07:36:547in the fully qualified variable name the variable itself is the last
8dot-separated segment and the section name is everything before the last
9dot. The variable names are case-insensitive and only alphanumeric
10characters are allowed. Some variables may appear multiple times.
11
12The syntax is fairly flexible and permissive; whitespaces are mostly
Junio C Hamanof1d14802006-06-08 00:48:1713ignored. The '#' and ';' characters begin comments to the end of line,
Junio C Hamano07824ce2006-04-25 07:36:5414blank lines are ignored, lines containing strings enclosed in square
15brackets start sections and all the other lines are recognized
16as setting variables, in the form 'name = value'. If there is no equal
17sign on the line, the entire line is taken as 'name' and the variable
18is recognized as boolean "true". String values may be entirely or partially
19enclosed in double quotes; some variables may require special value format.
20
21Example
22~~~~~~~
23
24# Core variables
25[core]
26; Don't trust file modes
27filemode = false
28
29# Our diff algorithm
30[diff]
31external = "/usr/local/bin/gnu-diff -u"
32renames = true
33
34Variables
35~~~~~~~~~
36
37Note that this list is non-comprehensive and not necessarily complete.
Junio C Hamanof1d14802006-06-08 00:48:1738For command-specific variables, you will find a more detailed description
39in the appropriate manual page. You will find a description of non-core
Junio C Hamano07824ce2006-04-25 07:36:5440porcelain configuration variables in the respective porcelain documentation.
41
42core.fileMode::
43If false, the executable bit differences between the index and
44the working copy are ignored; useful on broken filesystems like FAT.
45See gitlink:git-update-index[1]. True by default.
46
47core.gitProxy::
48A "proxy command" to execute (as 'command host port') instead
49of establishing direct connection to the remote server when
50using the git protocol for fetching. If the variable value is
51in the "COMMAND for DOMAIN" format, the command is applied only
52on hostnames ending with the specified domain string. This variable
53may be set multiple times and is matched in the given order;
54the first match wins.
Junio C Hamanof1d14802006-06-08 00:48:1755+
56Can be overridden by the 'GIT_PROXY_COMMAND' environment variable
57(which always applies universally, without the special "for"
58handling).
Junio C Hamano07824ce2006-04-25 07:36:5459
60core.ignoreStat::
61The working copy files are assumed to stay unchanged until you
62mark them otherwise manually - Git will not detect the file changes
63by lstat() calls. This is useful on systems where those are very
64slow, such as Microsoft Windows. See gitlink:git-update-index[1].
65False by default.
66
Junio C Hamano88a3a072006-05-04 08:01:4367core.preferSymlinkRefs::
68Instead of the default "symref" format for HEAD
69and other symbolic reference files, use symbolic links.
70This is sometimes needed to work with old scripts that
71expect HEAD to be a symbolic link.
Junio C Hamano07824ce2006-04-25 07:36:5472
Junio C Hamano341071d2006-06-04 07:24:4873core.logAllRefUpdates::
74If true, `git-update-ref` will append a line to
75"$GIT_DIR/logs/<ref>" listing the new SHA1 and the date/time
76of the update. If the file does not exist it will be
77created automatically. This information can be used to
78determine what commit was the tip of a branch "2 days ago".
79This value is false by default (no logging).
80
Junio C Hamano07824ce2006-04-25 07:36:5481core.repositoryFormatVersion::
82Internal variable identifying the repository format and layout
83version.
84
85core.sharedRepository::
86If true, the repository is made shareable between several users
87in a group (making sure all the files and objects are group-writable).
88See gitlink:git-init-db[1]. False by default.
89
90core.warnAmbiguousRefs::
91If true, git will warn you if the ref name you passed it is ambiguous
92and might match multiple refs in the .git/refs/ tree. True by default.
93
Junio C Hamanoa126a3b2006-07-04 04:55:2694core.compression:
95An integer -1..9, indicating the compression level for objects that
96are not in a pack file. -1 is the zlib and git default. 0 means no
97compression, and 1..9 are various speed/size tradeoffs, 9 being
98slowest.
99
Junio C Hamano33db4372006-06-07 19:51:45100alias.*::
101Command aliases for the gitlink:git[1] command wrapper - e.g.
102after defining "alias.last = cat-file commit HEAD", the invocation
103"git last" is equivalent to "git cat-file commit HEAD". To avoid
Junio C Hamanof1d14802006-06-08 00:48:17104confusion and troubles with script usage, aliases that
105hide existing git commands are ignored. Arguments are split by
106spaces, the usual shell quoting and escaping is supported.
107quote pair and a backslash can be used to quote them.
Junio C Hamano33db4372006-06-07 19:51:45108
Junio C Hamano07824ce2006-04-25 07:36:54109apply.whitespace::
110Tells `git-apply` how to handle whitespaces, in the same way
111as the '--whitespace' option. See gitlink:git-apply[1].
112
113diff.renameLimit::
114The number of files to consider when performing the copy/rename
115detection; equivalent to the git diff option '-l'.
116
117format.headers::
118Additional email headers to include in a patch to be submitted
119by mail. See gitlink:git-format-patch[1].
120
121gitcvs.enabled::
122Whether the cvs pserver interface is enabled for this repository.
123See gitlink:git-cvsserver[1].
124
125gitcvs.logfile::
126Path to a log file where the cvs pserver interface well... logs
127various stuff. See gitlink:git-cvsserver[1].
128
129http.sslVerify::
130Whether to verify the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:45131over HTTPS. Can be overridden by the 'GIT_SSL_NO_VERIFY' environment
Junio C Hamano07824ce2006-04-25 07:36:54132variable.
133
134http.sslCert::
135File containing the SSL certificate when fetching or pushing
Junio C Hamano33db4372006-06-07 19:51:45136over HTTPS. Can be overridden by the 'GIT_SSL_CERT' environment
Junio C Hamano07824ce2006-04-25 07:36:54137variable.
138
139http.sslKey::
140File containing the SSL private key when fetching or pushing
Junio C Hamano341071d2006-06-04 07:24:48141over HTTPS. Can be overridden by the 'GIT_SSL_KEY' environment
Junio C Hamano07824ce2006-04-25 07:36:54142variable.
143
144http.sslCAInfo::
145File containing the certificates to verify the peer with when
Junio C Hamano341071d2006-06-04 07:24:48146fetching or pushing over HTTPS. Can be overridden by the
Junio C Hamano07824ce2006-04-25 07:36:54147'GIT_SSL_CAINFO' environment variable.
148
149http.sslCAPath::
150Path containing files with the CA certificates to verify the peer
Junio C Hamano33db4372006-06-07 19:51:45151with when fetching or pushing over HTTPS. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:54152by the 'GIT_SSL_CAPATH' environment variable.
153
154http.maxRequests::
Junio C Hamano341071d2006-06-04 07:24:48155How many HTTP requests to launch in parallel. Can be overridden
Junio C Hamano07824ce2006-04-25 07:36:54156by the 'GIT_HTTP_MAX_REQUESTS' environment variable. Default is 5.
157
158http.lowSpeedLimit, http.lowSpeedTime::
159If the HTTP transfer speed is less than 'http.lowSpeedLimit'
160for longer than 'http.lowSpeedTime' seconds, the transfer is aborted.
Junio C Hamano341071d2006-06-04 07:24:48161Can be overridden by the 'GIT_HTTP_LOW_SPEED_LIMIT' and
Junio C Hamano07824ce2006-04-25 07:36:54162'GIT_HTTP_LOW_SPEED_TIME' environment variables.
163
164i18n.commitEncoding::
165Character encoding the commit messages are stored in; git itself
166does not care per se, but this information is necessary e.g. when
167importing commits from emails or in the gitk graphical history
168browser (and possibly at other places in the future or in other
169porcelains). See e.g. gitlink:git-mailinfo[1]. Defaults to 'utf-8'.
170
171merge.summary::
172Whether to include summaries of merged commits in newly created
173merge commit messages. False by default.
174
175pull.octopus::
176The default merge strategy to use when pulling multiple branches
177at once.
178
179pull.twohead::
180The default merge strategy to use when pulling a single branch.
181
182show.difftree::
183The default gitlink:git-diff-tree[1] arguments to be used
184for gitlink:git-show[1].
185
186showbranch.default::
187The default set of branches for gitlink:git-show-branch[1].
188See gitlink:git-show-branch[1].
189
190user.email::
191Your email address to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:48192Can be overridden by the 'GIT_AUTHOR_EMAIL' and 'GIT_COMMITTER_EMAIL'
Junio C Hamano07824ce2006-04-25 07:36:54193environment variables. See gitlink:git-commit-tree[1].
194
195user.name::
196Your full name to be recorded in any newly created commits.
Junio C Hamano341071d2006-06-04 07:24:48197Can be overridden by the 'GIT_AUTHOR_NAME' and 'GIT_COMMITTER_NAME'
Junio C Hamano07824ce2006-04-25 07:36:54198environment variables. See gitlink:git-commit-tree[1].
199
200whatchanged.difftree::
201The default gitlink:git-diff-tree[1] arguments to be used
202for gitlink:git-whatchanged[1].
203
204imap::
205The configuration variables in the 'imap' section are described
206in gitlink:git-imap-send[1].